[WIP] Add option to only aggregate documentation from selected package versions#107
Draft
kdayday wants to merge 3 commits intoJuliaComputing:mainfrom
Draft
[WIP] Add option to only aggregate documentation from selected package versions#107kdayday wants to merge 3 commits intoJuliaComputing:mainfrom
kdayday wants to merge 3 commits intoJuliaComputing:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds optional control over which version directories are copied into the aggregate site and injects a “See All Versions” option in the Documenter version selector that links to the package’s own gh-pages (or a custom URL). Useful when aggregating many repos with long version histories that might exceed Github Page's free 1 GB limit
New
MultiDocRefoptionsinclude_versions (Union{Vector{String}, Nothing}): If set (e.g.["stable", "dev"]), only these version directories are copied from upstream; root files (e.g. index.html, versions.js) are always copied. Reduces aggregate size when many versions exist.all_versions_url (Union{String, Nothing}): URL for the “See All Versions” link in the version selector wheninclude_versionsis set. If unset andgiturlis set, it is derived fromgiturl(e.g. https://github.com/org/pkg.jl.git → https://org.github.io/pkg.jl/).Behavior
When include_versions is set:
follow_symlinks = trueso symlinks likestable → v1.0.0become real directories in the aggregate.versions.jsis rewritten so the version selector only lists the kept versions.</body>in each doc HTML that adds a “See All Versions” option to the version<select>. Choosing it opens the package (or custom) URL in a new tab and restores the dropdown to the current version. Only absolutehttp(s)URLs are used for this link.include_versionsis unset, behavior is unchanged (full copy, no injection).